'\" t
.\"     Title: \fBndb_setup.py\fR
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 03/25/2015
.\"    Manual: MySQL Database System
.\"    Source: MySQL 5.6
.\"  Language: English
.\"
.TH "\FBNDB_SETUP\&.PY\FR" "1" "03/25/2015" "MySQL 5\&.6" "MySQL Database System"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.\" ndb_setup.py
.SH "NAME"
ndb_setup.py \- Start browser\-based Auti\-Installer for MySQL Cluster
.SH "SYNOPSIS"
.HP \w'\fBndb_setup\&.py\ [\fR\fB\fIoptions\fR\fR\fB]\fR\ 'u
\fBndb_setup\&.py [\fR\fB\fIoptions\fR\fR\fB]\fR
.SH "DESCRIPTION"
.\" MySQL Cluster Auto-Installer: setup program
.PP
\fBndb_setup\&.py\fR
starts the MySQL Cluster Auto\-Installer and opens the installer\*(Aqs Start page in the default Web browser\&.
.PP
This section describes usage of and program options for the command\-line tool only\&. For information about using the Auto\-Installer GUI that is spawned when
\fBndb_setup\&.py\fR
is invoked, see
Section\ \&18.2.1, \(lqThe MySQL Cluster Auto-Installer\(rq\&.
Usage.PP
All platforms:
.sp
.if n \{\
.RS 4
.\}
.nf
ndb_setup\&.py [\fIoptions\fR]
.fi
.if n \{\
.RE
.\}
.sp
.\" setup.bat: MySQL Cluster (Windows)
.\" MySQL Cluster Auto-Installer: setup program (Windows)
.PP
Additionally, on Windows platforms only:
.sp
.if n \{\
.RS 4
.\}
.nf
setup\&.bat [\fIoptions\fR]
.fi
.if n \{\
.RE
.\}
.PP
The following table includes all options that are supported by the MySQL Cluster installation and configuration program
\fBndb_setup\&.py\fR\&. Additional descriptions follow the table\&.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.B Table\ \&18.94.\ \& This table describes command-line options for the ndb_setup.py program
.TS
allbox tab(:);
lB lB lB.
T{
Format
T}:T{
Description
T}:T{
Added or Removed
T}
.T&
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l
l l l.
T{
.PP
--browser-start-page=filename,
.PP
-s
T}:T{
Page that the web browser opens when starting.
T}:T{
.PP
All MySQL 5.6 based releases
T}
T{
.PP
--ca-certs-file=filename,
.PP
-a
T}:T{
File containing list of client certificates allowed to connect to
      the server
T}:T{
.PP
All MySQL 5.6 based releases
T}
T{
.PP
--cert-file=filename,
.PP
-c
T}:T{
File containing X509 certificate that identifies the server.
      (Default: cfg.pem)
T}:T{
.PP
All MySQL 5.6 based releases
T}
T{
.PP
--debug-level=level,
.PP
-d
T}:T{
Python logging module debug level. One of DEBUG, INFO, WARNING
      (default), ERROR, or CRITICAL.
T}:T{
.PP
All MySQL 5.6 based releases
T}
T{
.PP
--help,
.PP
-h
T}:T{
Print help message
T}:T{
.PP
All MySQL 5.6 based releases
T}
T{
.PP
--key-file=file,
.PP
-k
T}:T{
Specify file containing private key (if not included in
      --cert-file)
T}:T{
.PP
All MySQL 5.6 based releases
T}
T{
.PP
--no-browser,
.PP
-n
T}:T{
Do not open the start page in a browser, merely start the tool
T}:T{
.PP
All MySQL 5.6 based releases
T}
T{
.PP
--port=#,
.PP
-p
T}:T{
Specify the port used by the web server
T}:T{
.PP
All MySQL 5.6 based releases
T}
T{
.PP
--server-log-file=file,
.PP
o
T}:T{
Log requests to this file. Use '-' to force logging to stderr
      instead.
T}:T{
.PP
All MySQL 5.6 based releases
T}
T{
.PP
--server-name=name,
.PP
-N
T}:T{
The name of the server to connect with
T}:T{
.PP
All MySQL 5.6 based releases
T}
T{
.PP
--use-https,
.PP
-S
T}:T{
Use secure (HTTPS) client-server connection
T}:T{
.PP
All MySQL 5.6 based releases
T}
.TE
.sp 1
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_setup.py: browser-start-page option
.\" browser-start-page option: ndb_setup.py
\fB\-\-browser\-start\-page=\fR\fB\fIfile\fR\fR,
\fB\-s\fR
.TS
allbox tab(:);
l l s s
l l l s
^ l l s.
T{
\fBCommand\-Line Format\fR
T}:T{
\-\-browser\-start\-page=filename
T}
T{
\fBPermitted Values\fR
T}:T{
\fBType\fR
T}:T{
string
T}
:T{
\fBDefault\fR
T}:T{
index\&.html
T}
.TE
.sp 1
Specify the file to open in the browser as the installation and configuration Start page\&. The default is
index\&.html\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_setup.py: ca-certs-file option
.\" ca-certs-file option: ndb_setup.py
\fB\-\-ca\-certs\-file=\fR\fB\fIfile\fR\fR,
\fB\-a\fR
.TS
allbox tab(:);
l l s s
l l l s
^ l l s.
T{
\fBCommand\-Line Format\fR
T}:T{
\-\-ca\-certs\-file=filename
T}
T{
\fBPermitted Values\fR
T}:T{
\fBType\fR
T}:T{
file name
T}
:T{
\fBDefault\fR
T}:T{
[none]
T}
.TE
.sp 1
Specify a file containing a list of client certificates which are allowed to connect to the server\&. The default is an empty string, which means that no client authentication is used\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_setup.py: cert-file option
.\" cert-file option: ndb_setup.py
\fB\-\-cert\-file=\fR\fB\fIfile\fR\fR,
\fB\-c\fR
.TS
allbox tab(:);
l l s s
l l l s
^ l l s.
T{
\fBCommand\-Line Format\fR
T}:T{
\-\-cert\-file=filename
T}
T{
\fBPermitted Values\fR
T}:T{
\fBType\fR
T}:T{
file name
T}
:T{
\fBDefault\fR
T}:T{
cfg\&.pem
T}
.TE
.sp 1
Specify a file containing an X509 certificate which identifies the server\&. It is possible for the certificate to be self\-signed\&. The default is
cfg\&.pem\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_setup.py: debug-level option
.\" debug-level option: ndb_setup.py
\fB\-\-debug\-level=\fR\fB\fIlevel\fR\fR,
\fB\-d\fR
.TS
allbox tab(:);
l l s s
l l l s
^ l l s
^ lt l s
^ ^ l s
^ ^ l s
^ ^ l s.
T{
\fBCommand\-Line Format\fR
T}:T{
\-\-debug\-level=level
T}
T{
\fBPermitted Values\fR
T}:T{
\fBType\fR
T}:T{
enumeration
T}
:T{
\fBDefault\fR
T}:T{
WARNING
T}
:T{
\fBValid Values\fR
T}:T{
DEBUG
T}
::T{
INFO
T}
::T{
ERROR
T}
::T{
CRITICAL
T}
.TE
.sp 1
Set the Python logging module debug level\&. This is one of
DEBUG,
INFO,
WARNING,
ERROR, or
CRITICAL\&.
WARNING
is the default\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_setup.py: help option
.\" help option: ndb_setup.py
\fB\-\-help\fR,
\fB\-h\fR
.TS
allbox tab(:);
l l s s.
T{
\fBCommand\-Line Format\fR
T}:T{
\-\-help
T}
.TE
.sp 1
Print a help message\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_setup.py: key-file option
.\" key-file option: ndb_setup.py
\fB\-\-key\-file=\fR\fB\fIfile\fR\fR,
\fB\-d\fR
.TS
allbox tab(:);
l l s s
l l l s
^ l l s.
T{
\fBCommand\-Line Format\fR
T}:T{
\-\-key\-file=file
T}
T{
\fBPermitted Values\fR
T}:T{
\fBType\fR
T}:T{
file name
T}
:T{
\fBDefault\fR
T}:T{
[none]
T}
.TE
.sp 1
Specify a file containing the private key if this is not included in the X509 certificate file (\fB\-\-cert\-file\fR)\&. The default is an empty string, which means that no such file is used\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_setup.py: no-browser option
.\" no-browser option: ndb_setup.py
\fB\-\-no\-browser\fR,
\fB\-n\fR
.TS
allbox tab(:);
l l s s.
T{
\fBCommand\-Line Format\fR
T}:T{
\-\-no\-browser
T}
.TE
.sp 1
Start the installation and configuration tool, but do not open the Start page in a browser\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_setup.py: port option
.\" port option: ndb_setup.py
\fB\-\-port=\fR\fB\fI#\fR\fR,
\fB\-p\fR
.TS
allbox tab(:);
l l s s
l l l s
^ l l s
^ l l s
^ l l s.
T{
\fBCommand\-Line Format\fR
T}:T{
\-\-port=#
T}
T{
\fBPermitted Values\fR
T}:T{
\fBType\fR
T}:T{
numeric
T}
:T{
\fBDefault\fR
T}:T{
8081
T}
:T{
\fBMin Value\fR
T}:T{
1
T}
:T{
\fBMax Value\fR
T}:T{
65535
T}
.TE
.sp 1
Set the port used by the web server\&. The default is 8081\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_setup.py: server-log-file option
.\" server-log-file option: ndb_setup.py
\fB\-\-server\-log\-file=\fR\fB\fIfile\fR\fR,
\fB\-o\fR
.TS
allbox tab(:);
l l s s
l l s s
l l l s
^ l l s
^ lt l s.
T{
\fBCommand\-Line Format\fR
T}:T{
\-\-server\-log\-file=file
T}
T{
\ \&
T}:T{
o
T}
T{
\fBPermitted Values\fR
T}:T{
\fBType\fR
T}:T{
file name
T}
:T{
\fBDefault\fR
T}:T{
ndb_setup\&.log
T}
:T{
\fBValid Values\fR
T}:T{
\- (Log to stderr)
T}
.TE
.sp 1
Log requests to this file\&. The default is
ndb_setup\&.log\&. To specify logging to
stderr, rather than to a file, use a
\-
(dash character) for the file name\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_setup.py: server-name option
.\" server-name option: ndb_setup.py
\fB\-\-server\-name=\fR\fB\fIhost\fR\fR,
\fB\-N\fR
.TS
allbox tab(:);
l l s s
l l l s
^ l l s.
T{
\fBCommand\-Line Format\fR
T}:T{
\-\-server\-name=name
T}
T{
\fBPermitted Values\fR
T}:T{
\fBType\fR
T}:T{
string
T}
:T{
\fBDefault\fR
T}:T{
localhost
T}
.TE
.sp 1
Specify the host name or IP address for the browser to use when connecting\&. The default is
localhost\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
.\" ndb_setup.py: use-https option
.\" use-https option: ndb_setup.py
\fB\-\-use\-https\fR,
\fB\-S\fR
.TS
allbox tab(:);
l l s s.
T{
\fBCommand\-Line Format\fR
T}:T{
\-\-use\-https
T}
.TE
.sp 1
Make the browser use a secure (HTTPS) connection with the server\&.
.RE
.SH "COPYRIGHT"
.br
.PP
Copyright \(co 1997, 2015, Oracle and/or its affiliates. All rights reserved.
.PP
This documentation is free software; you can redistribute it and/or modify it only under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.
.PP
This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License along with the program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA or see http://www.gnu.org/licenses/.
.sp
.SH "SEE ALSO"
For more information, please refer to the MySQL Reference Manual,
which may already be installed locally and which is also available
online at http://dev.mysql.com/doc/.
.SH AUTHOR
Oracle Corporation (http://dev.mysql.com/).
